Skip to content

docs: README を Usage 主体へ再構成する - #23

Merged
k163377 merged 5 commits into
mainfrom
docs/readme-usage-focus
Aug 3, 2026
Merged

docs: README を Usage 主体へ再構成する#23
k163377 merged 5 commits into
mainfrom
docs/readme-usage-focus

Conversation

@k163377

@k163377 k163377 commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

概要

README を過去の経緯(Motivation)中心から Usage 中心へ再構成する。

変更点

  • セットアップ例を kotlin("jvm") 主体へ入れ替え(multiplatform は注記側)
  • Motivation 節を廃止し、価値提案の 1 文を導入段落へ吸収。
    KT-25871 / sealedSubclasses の制約(R8 で空リスト化 = KT-37292)は Usage の注記 1 文へ縮約
  • 基本例へ entries.map { it.enumizedClass }(全末端クラス取得)を追加
  • sealed class の困りごと調査に基づくユースケース節を追加
    • Listing every case: entries によるピッカー生成・空グループ込みの集計軸
    • Round-tripping labels: label 送出と valueOfOrNull 解釈の往復・R8 耐性(::class.simpleName 対比)
    • Verifying per-kind wiring: when にできない外部組み立ての配線を entries で網羅検査
    • Exhaustive tests over every leaf: kind 起点の値の型を enumizedClass と突き合わせるテスト例
  • 既存 Status 例のコンパイル不能(data object の抽象プロパティ未実装)を修正
  • Maven のセットアップ節を <details> で折りたたみ(利用者が少ない想定)
  • IntelliJ の Registry 設定例スクリーンショットを追加

検証

  • ./gradlew checkVersionMentions green(kotlin("jvm") への入替は文脈パターン両対応済み)

🤖 Generated with Claude Code

k163377 and others added 5 commits August 3, 2026 21:00
利用者の多数派に合わせ kotlin("jvm") を主、multiplatform を注記側とする。

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
data object Deleted が抽象プロパティ remarks を実装しておらず
コンパイル不能だったため、抽象宣言をやめ各末端の固有プロパティとする。

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- Motivation 節を廃止し、価値提案の 1 文を導入段落へ吸収。
  KT-25871 / sealedSubclasses の制約(R8 で空リスト化 = KT-37292)は
  Usage の注記 1 文へ縮約
- 基本例へ entries.map { it.enumizedClass } による全末端クラス取得を追加
- ユースケース節を追加: 全ケース列挙(UI・集計軸)・label の永続化往復・
  per-kind 配線の網羅検査・kind 起点の値の型を enumizedClass と
  突き合わせる全末端テスト

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
利用者が少ない想定のため details 化し、既定表示を Gradle 中心とする。

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
kotlin.k2.only.bundled.compiler.plugins.enabled を無効化した Registry
ダイアログを assets へ追加し、Setup の手順文へ挿入する。

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@k163377
k163377 force-pushed the docs/readme-usage-focus branch from bbecff8 to 6fc10b7 Compare August 3, 2026 12:25
@k163377
k163377 marked this pull request as ready for review August 3, 2026 12:34
@k163377
k163377 merged commit 361b4a5 into main Aug 3, 2026
10 checks passed
@k163377
k163377 deleted the docs/readme-usage-focus branch August 3, 2026 12:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant